home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_hylafax.idb / usr / freeware / man / cat1 / sendfax.Z / sendfax
Encoding:
Text File  |  1999-07-16  |  42.2 KB  |  791 lines

  1.  
  2.  
  3.  
  4. SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuunnnneeee 22221111,,,, 1111999999996666))))        SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      sendfax - submit a facsimile job for transmission
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      sssseeeennnnddddffffaaaaxxxx [ _o_p_t_i_o_n_s ] [ _f_i_l_e_s...  ]
  13.  
  14. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.      _s_e_n_d_f_a_x submits one or more facsimile transmission requests
  16.      to a _H_y_l_a_F_A_X facsimile server.  Requests are normally
  17.      processed immediately, although they may also be queued for
  18.      transmission at a later time using a syntax identical to the
  19.      _a_t(1) command.  For each job that is queued, _s_e_n_d_f_a_x prints
  20.      a _j_o_b _i_d_e_n_t_i_f_i_e_r and a _j_o_b _g_r_o_u_p _i_d_e_n_t_i_f_i_e_r on the standard
  21.      output.  A job identifier is the token by which jobs are
  22.      identified within _H_y_l_a_F_A_X; job group identifiers are used to
  23.      reference a set of jobs that have been submitted at the same
  24.      time.  Job and job group identifiers can be supplied to the
  25.      _f_a_x_r_m(1) command to remove the jobs or to the _f_a_x_a_l_t_e_r(1)
  26.      command to alter job parameters.
  27.  
  28.      Facsimile are made from the concatenation of a cover page
  29.      (see below) and one or more files specified on the command
  30.      line.  If no files are supplied on the command line, _s_e_n_d_f_a_x
  31.      will read data from the standard input unless polling is
  32.      requested.  Cover pages are distinguished for the purpose of
  33.      generating ``_c_o_n_t_i_n_u_a_t_i_o_n _c_o_v_e_r _p_a_g_e_s'' on the server; these
  34.      are makeup cover pages that are automatically generated if a
  35.      job fails after sending the original user-specified cover
  36.      page.
  37.  
  38.      _s_e_n_d_f_a_x passes POSTSCRIPT and TIFF documents directly
  39.      through to the fax server for transmission, and attempts to
  40.      convert other file formats to either POSTSCRIPT or TIFF.  In
  41.      normal operation _s_e_n_d_f_a_x automatically converts ASCII-text,
  42.      _t_r_o_f_f(1) output, and Silicon Graphics format images for
  43.      transmission.  Support for other file formats can be easily
  44.      added through an extensible file typing and conversion
  45.      facility; see _t_y_p_e_r_u_l_e_s(4F).  Note that since TIFF Class F
  46.      documents are processed directly it is simple to forward a
  47.      received facsimile.
  48.  
  49.      By default _s_e_n_d_f_a_x will generate a cover page for each
  50.      facsimile that is to be transmitted.  This cover page is
  51.      created by the ancillary _f_a_x_c_o_v_e_r(1) program using
  52.      information deduced by _s_e_n_d_f_a_x and by information supplied
  53.      on the command line.  Automatic cover page generation may be
  54.      suppressed with the ----nnnn option.
  55.  
  56.      In addition to sending documents, _s_e_n_d_f_a_x can be used to
  57.      poll a remote facsimile machine to retrieve waiting
  58.      documents.  If the ----pppp option is specified, a polling request
  59.      will be submitted to each destination.  If a poll request is
  60.  
  61.  
  62.  
  63. Page 1                                          (printed 6/24/99)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuunnnneeee 22221111,,,, 1111999999996666))))        SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))
  71.  
  72.  
  73.  
  74.      made in conjunction with the transmission of documents, the
  75.      poll request will take place after the documents are
  76.      transmitted.  Documents retrieved by polling are returned to
  77.      the requestor by electronic mail and may be viewed with a
  78.      suitable viewer program.
  79.  
  80.      One or more destinations must be specified on the command
  81.      line using the ----dddd option.  A destination is the dialing
  82.      string to use to contact the remote fax machine.  Phone
  83.      numbers may include non-alphanumeric characters for
  84.      readability-only alphanumerics and ``+'' (for denoting a
  85.      country code) are significant in placing a call.  Alphabetic
  86.      characters are automatically mapped to their numeric key
  87.      equivalents: ``abcABC'' to ``2'', ``defDEF'' to ``3'', etc.
  88.      Dialing prefixes, such as ``1'' and ``011'' (for long
  89.      distance calling in the United States) need not be included
  90.      if an unambigous number is specified.  Examples of
  91.      unambiguous phone numbers are:
  92.           +31.77.594.131      _t_o _c_a_l_l _t_h_e _N_e_t_h_e_r_l_a_n_d_s
  93.           +14159657824        _t_o _c_a_l_l _C_a_l_i_f_o_r_n_i_a
  94.           9657824             _t_o _m_a_k_e _a _l_o_c_a_l _c_a_l_l
  95.           1-215-356-1666      _t_o _c_a_l_l _P_e_n_n_s_y_l_v_a_n_i_a _f_r_o_m _w_i_t_h_i_n _t_h_e _U_S
  96.      Non-numeric strings, such as ``*70'' (to defeat call
  97.      waiting), may be included in the destination phone number.
  98.      Whether or not they are stripped from the string used to
  99.      dial the destination fax machine is dependent on the
  100.      dialstring rules configured for use on the server; c.f.
  101.      _c_o_n_f_i_g(4F) and _d_i_a_l_r_u_l_e_s(4F).
  102.  
  103.      A destination may also be specified as _u_s_e_r@_f_a_x-_n_u_m_b_e_r.  In
  104.      this case the _u_s_e_r string will be passed to _f_a_x_c_o_v_e_r as the
  105.      identity of the recipient.  Note that multi-word names must
  106.      be enclosed in quote marks; for example, ``Sam
  107.      Leffler@+1.415.555.1212''.
  108.  
  109.      The order of options on the command line is significant.
  110.      Each fax to be transmitted is assigned the current value of
  111.      parameters specified on the command line; e.g. whether or
  112.      not to generate a cover page.  This means that options that
  113.      specify parameters for a particular destination must precede
  114.      the dialstring specified with the ----dddd option.  For example,
  115.  
  116.           sendfax -n -d 5551212 /etc/passwd
  117.  
  118.      submits a fax to 5551212 that has no cover page while
  119.  
  120.           sendfax -d 5551212 -n /etc/passwd
  121.  
  122.      submits the same fax but with the default cover page
  123.      handling.  Note also that parameter values persist across ----dddd
  124.      options so the following
  125.  
  126.  
  127.  
  128. Page 2                                          (printed 6/24/99)
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135. SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuunnnneeee 22221111,,,, 1111999999996666))))        SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))
  136.  
  137.  
  138.  
  139.           sendfax -n -d 5551212 -d 5551313 /etc/network
  140.  
  141.      submits two facsimile, both of which have no cover page.
  142.  
  143. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  144.      ----1111          Transmit facsimile documents using 1-D MR
  145.                  compression.  By default _H_y_l_a_F_A_X will use the
  146.                  optimal compression scheme supported by the
  147.                  transmitting modem and receiving facsimile
  148.                  device.
  149.  
  150.      ----2222          Transmit facsimile documents using 2-D MR
  151.                  compression, if possible.  By default _H_y_l_a_F_A_X
  152.                  will use the optimal compression scheme
  153.                  supported by the transmitting modem and
  154.                  receiving facsimile device.
  155.  
  156.      ----aaaa _t_i_m_e     Schedule transmission at the indicated _t_i_m_e.
  157.                  Times are specified using the syntax of the
  158.                  _a_t(1) command; e.g. ``now + 30 minutes'' to
  159.                  schedule transmission 30 minutes in the future.
  160.                  By default, _s_e_n_d_f_a_x schedules facsimile for
  161.                  ``now''.
  162.  
  163.      ----bbbb _s_p_e_e_d    Transmit facsimile documents using a signalling
  164.                  rate that is constrained to be at least _s_p_e_e_d
  165.                  bits/second.  If the specified speed is greater
  166.                  than the transmitting modem or receiver is
  167.                  capable of, it is reduced to the highest
  168.                  possible speed both devices support.  If a
  169.                  negotiated signalling rate greater than or equal
  170.                  to _s_p_e_e_d cannot be negotiated then the job is
  171.                  aborted.  Possible speeds are: 2400, 4800, 7200,
  172.                  9600, 12000, and 14400.  By default _H_y_l_a_F_A_X will
  173.                  use the fastest possible rate supported by the
  174.                  transmitting modem and receiving facsimile
  175.                  device.
  176.  
  177.      ----BBBB _s_p_e_e_d    Try to transmit facsimile documents using the
  178.                  desired signalling rate.  Possible speeds are:
  179.                  2400, 4800, 7200, 9600, 12000, and 14400.  If
  180.                  the specified speed is greater than the
  181.                  transmitting modem or receiver is capable of, it
  182.                  is reduced to the highest possible speed both
  183.                  devices support.  By default _H_y_l_a_F_A_X will use
  184.                  the fastest possible rate supported by the
  185.                  transmitting modem and receiving facsimile
  186.                  device (unless restricted by other server
  187.                  configuration); this option can be used to
  188.                  reduce the speed.  Note that international calls
  189.                  are frequently more reliable when transmissions
  190.                  are restricted to 9600 bits/second.
  191.  
  192.  
  193.  
  194. Page 3                                          (printed 6/24/99)
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201. SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuunnnneeee 22221111,,,, 1111999999996666))))        SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))
  202.  
  203.  
  204.  
  205.      ----cccc _c_o_m_m_e_n_t_s Pass _c_o_m_m_e_n_t_s to the _f_a_x_c_o_v_e_r(1) program for
  206.                  inclusion in the comments field of any generated
  207.                  cover page.
  208.  
  209.      ----DDDD          Enable notification by electronic mail when the
  210.                  facsimile has been delivered.  By default
  211.                  _H_y_l_a_F_A_X will notify the submitter only if there
  212.                  is a problem with a job.
  213.  
  214.      ----dddd _d_e_s_t_i_n_a_t_i_o_n
  215.                  Create a job to transmit the supplied documents
  216.                  to a facsimile machine at the indicated
  217.                  _d_e_s_t_i_n_a_t_i_o_n.  If the _d_e_s_t_i_n_a_t_i_o_n is of the form
  218.                  ``_u_s_e_r@_p_h_o_n_e-_n_u_m_b_e_r'' then any cover page will
  219.                  show _u_s_e_r as the intended receipient.
  220.  
  221.      ----EEEE          Disable use of the Error Correction Mode (ECM)
  222.                  when transmitting page data.  By default _H_y_l_a_F_A_X
  223.                  will attempt to use ECM when both the
  224.                  trasmitting modem and receiving device support
  225.                  it.  Note that international calls are sometimes
  226.                  faster when ECM is disabled.  Beware also that
  227.                  some modems and/or facsimile devices do not
  228.                  properly implement ECM causing transmission
  229.                  failures.
  230.  
  231.      ----ffff _f_r_o_m     Use _f_r_o_m as the identity of the facsimile
  232.                  sender.  Otherwise the sender is the user that
  233.                  invoked _s_e_n_d_f_a_x.  The sender is an account name
  234.                  to which the _H_y_l_a_F_A_X software should direct
  235.                  notification messages.  The _f_r_o_m identity may be
  236.                  a fullblown ``From:'' line, e.g.  e.g. ``Joe
  237.                  Blow <joe@foo.com>'' and ``joe@foo.com (Joe
  238.                  Blow)'' are acceptable.  If no host-part is
  239.                  specified in the _f_r_o_m string the local hostname
  240.                  is used.  This option is useful when _s_e_n_d_f_a_x is
  241.                  invoked on behalf of another user, such as in
  242.                  the implementation of an electronic mail to fax
  243.                  gateway.
  244.  
  245.      ----FFFF _f_o_r_m_a_t   Use the specified _f_o_r_m_a_t when imaging tag lines
  246.                  on outgoing pages.  Consult the description of
  247.                  the TTTTaaaaggggLLLLiiiinnnneeeeFFFFoooorrrrmmmmaaaatttt parameter in _c_o_n_f_i_g(4F) for an
  248.                  explanation of how to construct a format string.
  249.  
  250.                  _N_o_t_e _t_h_a_t _m_a_n_y _l_o_c_a_l_e_s _r_e_q_u_i_r_e _t_h_a_t _p_r_o_p_e_r
  251.                  _i_d_e_n_t_i_f_i_c_a_t_i_o_n _a_p_p_e_a_r _o_n _a_l_l _t_r_a_n_s_m_i_t_t_e_d
  252.                  _f_a_c_s_i_m_i_l_e; _w_h_e_n _u_s_i_n_g _t_h_i_s _f_a_c_i_l_i_t_y _o_n_e _s_h_o_u_l_d
  253.                  _a_l_w_a_y_s _i_n_c_l_u_d_e _p_r_o_p_e_r _i_d_e_n_t_i_f_i_c_a_t_i_o_n (_e._g. _a
  254.                  _p_h_o_n_e _n_u_m_b_e_r) _i_n _t_h_e _i_m_a_g_e_d _t_a_g_l_i_n_e_s.
  255.  
  256.      ----hhhh [_m_o_d_e_m@]_h_o_s_t[:_p_o_r_t]
  257.  
  258.  
  259.  
  260. Page 4                                          (printed 6/24/99)
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267. SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuunnnneeee 22221111,,,, 1111999999996666))))        SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))
  268.  
  269.  
  270.  
  271.                  Force the jobs to be processed on a specific
  272.                  _h_o_s_t and, optionally, using a particular _m_o_d_e_m.
  273.                  The _h_o_s_t may be either a symbolic name or a
  274.                  network address.  If no ----hhhh option is supplied,
  275.                  _s_e_n_d_f_a_x uses the FAXSERVER environment variable
  276.                  to identify the _H_y_l_a_F_A_X server to which the jobs
  277.                  should be directed.  If no server is specified
  278.                  then _s_e_n_d_f_a_x attempts to contact a server on the
  279.                  local host.  If no modem is specified, the job
  280.                  will be submitted to any available modem.
  281.  
  282.      ----iiii _i_d_e_n_t_i_f_i_e_r
  283.                  Use the _i_d_e_n_t_i_f_i_e_r string in any notification
  284.                  messages instead of the usual job identifier
  285.                  number.  This option is useful for applications
  286.                  that cross reference notification messages
  287.                  against job submissions.
  288.  
  289.      ----IIII _t_i_m_e     If a job must be requeued because of a
  290.                  communication failure schedule the retry
  291.                  according to the specified _t_i_m_e.  Times are
  292.                  given in seconds.  Minutes, hours, and days can
  293.                  be specified with ``_m_i_n'', ``_h_o_u_r'', and ``_d_a_y''
  294.                  suffixes, respectively.  By default _H_y_l_a_F_A_X
  295.                  reschedules jobs using retry times that depend
  296.                  on the manner in which the job failed; this
  297.                  interface permits a user to override this
  298.                  algorithm and specify a single fixed retry time
  299.                  for all communication failures.
  300.  
  301.      ----kkkk _t_i_m_e     Kill the job if it does not complete in the
  302.                  indicated _t_i_m_e.  As for the ----aaaa option, the _t_i_m_e
  303.                  is specifed using notation compatible with
  304.                  _a_t(1).  Note that the _t_i_m_e is relative to the
  305.                  time of the initial transmission attempt.  The
  306.                  default kill time is ``now +1 day'' (one day
  307.                  from the time the job is first processed).  To
  308.                  retry for an hour, ``now +1 hour'' could be
  309.                  used.
  310.  
  311.      ----llll          Transmit the facsimile at a vertical resolution
  312.                  of 98 lines/inch; otherwise known as _l_o_w
  313.                  _r_e_s_o_l_u_t_i_o_n.
  314.  
  315.      ----mmmm          Transmit the facsimile at a vertical resolution
  316.                  of 196 lines/inch; otherwise known as _m_e_d_i_u_m
  317.                  _r_e_s_o_l_u_t_i_o_n or _f_i_n_e _m_o_d_e.
  318.  
  319.      ----MMMM _m_s_t      Transmit facsimile documents using the specified
  320.                  minimum scanline time.  Possible times are: 0ms,
  321.                  5ms, 10ms2, 10ms, 20ms2, 20ms, 40ms2, and 40ms.
  322.                  If the specified time is less than the
  323.  
  324.  
  325.  
  326. Page 5                                          (printed 6/24/99)
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333. SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuunnnneeee 22221111,,,, 1111999999996666))))        SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))
  334.  
  335.  
  336.  
  337.                  transmitting modem or receiver is capable of, it
  338.                  is increased to the lowest possible time both
  339.                  devices support.  By default _H_y_l_a_F_A_X will use
  340.                  the lowest possible time supported by the
  341.                  transmitting modem and receiving facsimile
  342.                  device (unless restricted by other server
  343.                  configuration).  This option is mostly useful
  344.                  for debugging.
  345.  
  346.      ----nnnn          Suppress the automatic generation of a cover
  347.                  page for subsequent facsimile.  Note that
  348.                  polling requests do not receive a cover page
  349.                  unless they are combined with the transmission
  350.                  of one or more files.
  351.  
  352.      ----NNNN          Do not notify the sender by electronic mail when
  353.                  the facsimile has been delivered or requeued.
  354.  
  355.      ----pppp          Poll each destination for any available
  356.                  documents.  If a poll request is made together
  357.                  with document transmission, the poll operation
  358.                  is done after the documents are transmitted.
  359.                  Documents received by polling are returned to
  360.                  the sender by electronic mail.
  361.  
  362.      ----PPPP _p_r_i_o_r_i_t_y Assign the specified scheduling _p_r_i_o_r_i_t_y to
  363.                  subsequent jobs.  A priority is an integer value
  364.                  in the range [0-255].  Lower values result in
  365.                  higher priority processing.  By default, each
  366.                  job is assigned 127 for an initial scheduling
  367.                  priority.  A job's priority is raised
  368.                  (numerically lowered) for each failed attempt to
  369.                  transmit so that retransmit attempts are done
  370.                  ahead of newly submitted jobs.  The _p_r_i_o_r_i_t_y may
  371.                  also be specified as one of the following
  372.                  symbolic names:  _d_e_f_a_u_l_t or _n_o_r_m_a_l (127), _b_u_l_k
  373.                  or _j_u_n_k (207), _h_i_g_h (63).
  374.  
  375.      ----RRRR          Enable notification by electronic mail when the
  376.                  facsimile has been delivered and when it is
  377.                  requeued for retransmission.  By default _H_y_l_a_F_A_X
  378.                  will notify the submitter only if there is a
  379.                  problem with a job.
  380.  
  381.      ----rrrr _r_e_g_a_r_d_i_n_g
  382.                  Pass _r_e_g_a_r_d_i_n_g to the _f_a_x_c_o_v_e_r(1) program as the
  383.                  value of the ``Re:'' field of any generated
  384.                  cover page.
  385.  
  386.      ----ssss _s_i_z_e     Set the page size to use for the transmitted
  387.                  facsimile.  Facsimile are normally imaged with a
  388.                  system-default page size (usually letter-size
  389.  
  390.  
  391.  
  392. Page 6                                          (printed 6/24/99)
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399. SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuunnnneeee 22221111,,,, 1111999999996666))))        SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))
  400.  
  401.  
  402.  
  403.                  pages, 8.5" by 11", for sites in North America).
  404.                  Alternate page sizes are specified symbolically
  405.                  using either the name or abbreviation of an
  406.                  entry in the _p_a_g_e_s_i_z_e_s(4F) database; e.g.  _a_3
  407.                  (ISO A3), _a_4 (ISO A4), _a_5 (ISO A5), _a_6 (ISO A6),
  408.                  _b_4 (ISO B4), _n_a-_l_e_t (North American Letter),
  409.                  _u_s-_l_e_g (American Legal), _u_s-_l_e_d (American
  410.                  Ledger), _u_s-_e_x_e (American Executive), _j_p-_l_e_t
  411.                  (Japanese Letter), and _j_p-_l_e_g (Japanese Legal).
  412.                  Comparisons are case-insensitive and any match
  413.                  of a substring of the full page-size name is
  414.                  sufficient; e.g. ``legal'' would match
  415.                  ``American Legal''.
  416.  
  417.                  Note that it may not be permissible to image
  418.                  into the full page area; the guaranteed
  419.                  reproducible area for a page is typically inset.
  420.                  Also, note that while arbitrary page sizes can
  421.                  be specified through the page size database,
  422.                  only a limited set of page dimensions are
  423.                  supported by the Group 3 facsimile protocol.
  424.                  Thus if an odd-size facsimile is submitted for
  425.                  transmission it may not be possible to determine
  426.                  if it can be sent until the fax server
  427.                  establishes communication with the remote
  428.                  facsimile machine.
  429.  
  430.      ----tttt _t_r_i_e_s    Make no more than _t_r_i_e_s attempts to send the
  431.                  facsimile.  By default, _H_y_l_a_F_A_X will terminate a
  432.                  job if:  3 consecutive attempts to send a
  433.                  particular page fail, or it appears the receiver
  434.                  is not a facsimile machine.  Otherwise _H_y_l_a_F_A_X
  435.                  places no limit on the _n_u_m_b_e_r of attempts to
  436.                  send a facsimile, instead terminating a job if
  437.                  it is not completed within a _k_i_l_l _t_i_m_e timeout
  438.                  interval.  Note that a try is a call in which
  439.                  carrier is established and the facsimile
  440.                  protocol is commenced; this is contrasted with a
  441.                  call attempt that might have failed because the
  442.                  line was busy.
  443.  
  444.      ----xxxx _c_o_m_p_a_n_y  Pass _c_o_m_p_a_n_y to the _f_a_x_c_o_v_e_r(1) program as the
  445.                  destination company name.
  446.  
  447.      ----yyyy _l_o_c_a_t_i_o_n Pass _l_o_c_a_t_i_o_n to the _f_a_x_c_o_v_e_r(1) program as the
  448.                  destination company's location.
  449.  
  450.      ----vvvv          Print information on the standard output about
  451.                  each conversion and cover sheet generation
  452.                  operation it does.  If ----vvvv is specified twice,
  453.                  the protocol between _s_e_n_d_f_a_x and the _h_f_a_x_d
  454.                  server process that does the submission work on
  455.  
  456.  
  457.  
  458. Page 7                                          (printed 6/24/99)
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465. SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuunnnneeee 22221111,,,, 1111999999996666))))        SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))
  466.  
  467.  
  468.  
  469.                  the remote machine is also displayed.
  470.  
  471. CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  472.      _s_e_n_d_f_a_x reads configuration information from the files
  473.      ////uuuussssrrrr////ffffrrrreeeeeeeewwwwaaaarrrreeee////lllliiiibbbb////ffffaaaaxxxx////hhhhyyyyllllaaaa....ccccoooonnnnffff,
  474.      ////uuuussssrrrr////ffffrrrreeeeeeeewwwwaaaarrrreeee////lllliiiibbbb////ffffaaaaxxxx////sssseeeennnnddddffffaaaaxxxx....ccccoooonnnnffff, and ~~~~////....hhhhyyyyllllaaaarrrrcccc; in that
  475.      order.  Configuration files follow the conventions described
  476.      in _h_y_l_a_f_a_x(1).  The following configuration parameters are
  477.      recognized:
  478.      TTTTaaaagggg              TTTTyyyyppppeeee       DDDDeeeeffffaaaauuuulllltttt      DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
  479.      AutoCoverPage    boolean    Yes          automatically generate cover page
  480.      ChopThreshold    float      3.0          page chopping threshold
  481.      CoverCmd         string     _s_e_e _b_e_l_o_w    pathname of cover sheet program
  482.      Cover-Comments   string     -            cover page comments string
  483.      Cover-Company    string     -            cover page company name string
  484.      Cover-Location   string     -            cover page company location string
  485.      Cover-Regarding  string     -            cover page regarding string
  486.      Cover-Template   string     -            cover page template filename
  487.      Cover-Voice      string     -            cover page voice number string
  488.      DateFormat       string     -            cover page date format string
  489.      DesiredEC        boolean    -            desired use of ECM
  490.      DesiredMST       string     -            desired minimum scanling time to use
  491.      DesiredSpeed     integer    -            desired signalling rate to use
  492.      DialRules        string     _s_e_e _b_e_l_o_w    file containing dialstring rules
  493.      From             string     -            sender's identity
  494.      HRes             float      204.         horizontal resolution
  495.      Host             string     localhost    host to contact for service
  496.      KillTime         string     -            time to expire job
  497.      MailAddr         string     -            mail address for notification messages
  498.      MaxDials         integer    12           times to retry dialing
  499.      MaxTries         integer    3            times to retry transmission
  500.      MinSpeed         integer    -            minimum acceptable signalling rate
  501.      Modem            string     -            modem to use on server
  502.      Notify           string     none         control email notification
  503.      PageChop         string     default      control page chop handling
  504.      PageLength       float      -            page length in millimeters
  505.      PageSize         string     default      page size by name
  506.      PageWidth        float      -            page width in millimeters
  507.      Port             integer    4559         port to use in contacting server
  508.      Priority         string     default      job scheduling priority
  509.      Protocol         string     tcp          protocol to use in contacting server
  510.      RetryTime        string     -            delay between failed attempts to send
  511.      SendTime         string     -            time to send job
  512.      TagLine          string     -            tagline format string
  513.      TypeRules        string     _s_e_e _b_e_l_o_w    file containing file typing rules
  514.      VRes             float      98.          vertical resolution
  515.      Verbose          boolean    No           whether or not to enable protocol tracing
  516.  
  517.      The configuration parameters are explained below.  Certain
  518.      configuration parameters, notably those for setting strings
  519.      on automatically generated cover pages, are defined mainly
  520.      for use by other _H_y_l_a_F_A_X programs that share common code
  521.  
  522.  
  523. Page 8                                          (printed 6/24/99)
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530. SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuunnnneeee 22221111,,,, 1111999999996666))))        SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))
  531.  
  532.  
  533.  
  534.      used by _s_e_n_d_f_a_x.
  535.  
  536.      AAAAuuuuttttooooCCCCoooovvvveeeerrrrPPPPaaaaggggeeee   Control whether or not a cover page is
  537.                      automatically generated for each job.
  538.                      (Equivalent to the ----nnnn option.)
  539.  
  540.      CCCChhhhooooppppTTTThhhhrrrreeeesssshhhhoooolllldddd   The amount of white space, in inches, that
  541.                      must be present at the bottom of a page
  542.                      before _H_y_l_a_F_A_X will attempt to truncate the
  543.                      page transmission.
  544.  
  545.      CCCCoooovvvveeeerrrrCCCCmmmmdddd        The absolute pathname of the program to use
  546.                      to generate cover pages.  The default cover
  547.                      sheet program is ////uuuussssrrrr////ffffrrrreeeeeeeewwwwaaaarrrreeee////bbbbiiiinnnn////ffffaaaaxxxxccccoooovvvveeeerrrr.
  548.  
  549.      CCCCoooovvvveeeerrrr----CCCCoooommmmmmmmeeeennnnttttssss  The comments string to pass to the cover
  550.                      sheet program when auto-generating cover
  551.                      pages.
  552.  
  553.      CCCCoooovvvveeeerrrr----CCCCoooommmmppppaaaannnnyyyy   The company name string to pass to the cover
  554.                      sheet program when auto-generating cover
  555.                      pages.
  556.  
  557.      CCCCoooovvvveeeerrrr----LLLLooooccccaaaattttiiiioooonnnn  The company location string to pass to the
  558.                      cover sheet program when auto-generating
  559.                      cover pages.
  560.  
  561.      CCCCoooovvvveeeerrrr----RRRReeeeggggaaaarrrrddddiiiinnnngggg The regarding string to pass to the cover
  562.                      sheet program when auto-generating cover
  563.                      pages.
  564.  
  565.      CCCCoooovvvveeeerrrr----TTTTeeeemmmmppppllllaaaatttteeee  The absolute pathname of a cover sheet
  566.                      template file to use in auto-generating
  567.                      cover pages.
  568.  
  569.      CCCCoooovvvveeeerrrr----VVVVooooiiiicccceeee     The voice number string to pass to the cover
  570.                      sheet program when auto-generating cover
  571.                      pages.
  572.  
  573.      DDDDaaaatttteeeeFFFFoooorrrrmmmmaaaatttt      The _s_t_r_f_t_i_m_e(3) format string to pass to the
  574.                      cover page command when auto-generating
  575.                      cover pages.
  576.  
  577.      DDDDeeeessssiiiirrrreeeeddddEEEECCCC       Whether or not to request the use of the
  578.                      optional Error Correct Mode (ECM) when
  579.                      transmitting facsimile.  (Equivalent to the
  580.                      ----EEEE option.)
  581.  
  582.      DDDDeeeessssiiiirrrreeeeddddMMMMSSSSTTTT      The desired minimum scanline time to use
  583.                      when transmitting facsimile.  (Equivalent to
  584.                      the ----MMMM option.)
  585.  
  586.  
  587.  
  588.  
  589. Page 9                                          (printed 6/24/99)
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596. SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuunnnneeee 22221111,,,, 1111999999996666))))        SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))
  597.  
  598.  
  599.  
  600.      DDDDeeeessssiiiirrrreeeeddddSSSSppppeeeeeeeedddd    The desired signalling rate to the use when
  601.                      transmitting facsimile.  (Equivalent to the
  602.                      ----BBBB option.)
  603.  
  604.      DDDDiiiiaaaallllRRRRuuuulllleeeessss       The name of the file containing the
  605.                      dialstring processing rules to when
  606.                      preparing an externally visible
  607.                      representation of the dialstring (e.g. to
  608.                      strip credit card numbers).  By default this
  609.                      is /usr/freeware/lib/fax/dialrules.
  610.  
  611.      FFFFrrrroooommmm            The sender's identity.  (Equivalent to the
  612.                      ----ffff option.)
  613.  
  614.      HHHHoooosssstttt            The host to contact for service.
  615.                      (Equivalent to the ----hhhh option.)
  616.  
  617.      HHHHRRRReeeessss            The horizontal resolution to use when
  618.                      transmitting facsimile.  (NB: _t_h_i_s _c_u_r_r_e_n_t_l_y
  619.                      _h_a_s _n_o _e_f_f_e_c_t.)
  620.  
  621.      KKKKiiiillllllllTTTTiiiimmmmeeee        The expiration time to assign to each job.
  622.                      (Equivalent to the ----kkkk option.)
  623.  
  624.      MMMMaaaaiiiillllAAAAddddddddrrrr        The electronic mail address to direct
  625.                      notification messages from the server.  If
  626.                      this string is specified without an
  627.                      ``@hostname'' part then the local hostname
  628.                      will automatically be appended.  (Equivalent
  629.                      to the ----ffff option.)
  630.  
  631.      MMMMaaaaxxxxDDDDiiiiaaaallllssss        The maximum number of times to dial the
  632.                      phone for each job.  (Equivalent to the ----TTTT
  633.                      option.)
  634.  
  635.      MMMMaaaaxxxxTTTTrrrriiiieeeessss        The maximum number of times to retry sending
  636.                      a job.  (Equivalent to the ----tttt option.)
  637.  
  638.      MMMMiiiinnnnSSSSppppeeeeeeeedddd        The minimum acceptable signalling rate to
  639.                      use when transmitting facsimile.
  640.                      (Equivalent to the ----bbbb option.)
  641.  
  642.      MMMMooooddddeeeemmmm           The modem to use on the server.  (Equivalent
  643.                      to the ----hhhh option.)
  644.  
  645.      NNNNoooottttiiiiffffyyyy          Control the email notification messages from
  646.                      the server.  This string may be one of
  647.                      ``done'', ``none'', ``requeued'' or
  648.                      ``default'' with an optionally preceding
  649.                      ``when '' (e.g. ``when done'').  Note that
  650.                      ``when requeued'' implies ``when done''.
  651.                      (Equivalent to the ----DDDD, ----RRRR, and ----NNNN options.)
  652.  
  653.  
  654.  
  655. Page 10                                         (printed 6/24/99)
  656.  
  657.  
  658.  
  659.  
  660.  
  661.  
  662. SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuunnnneeee 22221111,,,, 1111999999996666))))        SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))
  663.  
  664.  
  665.  
  666.      PPPPaaaaggggeeeeCCCChhhhoooopppp        Control page chop handling when transmitting
  667.                      facsimile.  This string may be one of
  668.                      ``none'', ``all'', or ``last' to have no
  669.                      pages chopped, all pages chopped, or only
  670.                      the last page chopped; respectively.  Page
  671.                      chopping is controlled by the CCCChhhhooooppppTTTThhhhrrrreeeesssshhhhoooolllldddd
  672.                      parameter.
  673.  
  674.      PPPPaaaaggggeeeeLLLLeeeennnnggggtttthhhh      Set the transmitted page length in
  675.                      millimeters.
  676.  
  677.      PPPPaaaaggggeeeeSSSSiiiizzzzeeee        Set the page dimensions according to an
  678.                      entry in the _p_a_g_e_s_i_z_e_s(4F) database.
  679.                      (Equivalent to the ----ssss option.)
  680.  
  681.      PPPPaaaaggggeeeeWWWWiiiiddddtttthhhh       Set the transmitted page width in
  682.                      millimeters.
  683.  
  684.      PPPPoooorrrrtttt            The network port to contact for service.
  685.                      (Eqvuialent to the ----hhhh option.)
  686.  
  687.      PPPPrrrriiiioooorrrriiiittttyyyy        The scheduling priority to assign to each
  688.                      job.  (Equivalent to the ----PPPP option.)
  689.  
  690.      PPPPrrrroooottttooooccccoooollll        The name of the communication protocol to
  691.                      use when contacting a server.  (Equivalent
  692.                      to the FFFFAAAAXXXXSSSSEEEERRRRVVVVIIIICCCCEEEE environment variable.)
  693.  
  694.      RRRReeeettttrrrryyyyTTTTiiiimmmmeeee       The time to delay between job retries due to
  695.                      a communication failure.  (Equivalent to the
  696.                      ----IIII option.)
  697.  
  698.      SSSSeeeennnnddddTTTTiiiimmmmeeee        The time to send jobs.  (Equivalent to the
  699.                      ----aaaa option.)
  700.  
  701.      TTTTaaaaggggLLLLiiiinnnneeee         The tagline format string to use when
  702.                      transmitting facsimile.  (Equivalent to the
  703.                      ----FFFF option.)
  704.  
  705.      TTTTyyyyppppeeeeRRRRuuuulllleeeessss       The name of the file containing file type
  706.                      conversion rules.  By default this is
  707.                      /usr/freeware/lib/fax/typerules.
  708.  
  709.      VVVVeeeerrrrbbbboooosssseeee         Control protocol tracing.  (Equivalent to
  710.                      the ----vvvvvvvv option.)
  711.  
  712.      VVVVRRRReeeessss            Set the vertical resolution in lines/inch to
  713.                      use when transmitting facsimile.
  714.                      (Equivalent to the ----mmmm and ----llll options.)
  715.  
  716. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  717.      The following messages are generated because of problems
  718.  
  719.  
  720.  
  721. Page 11                                         (printed 6/24/99)
  722.  
  723.  
  724.  
  725.  
  726.  
  727.  
  728. SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuunnnneeee 22221111,,,, 1111999999996666))))        SSSSEEEENNNNDDDDFFFFAAAAXXXX((((1111))))
  729.  
  730.  
  731.  
  732.      encountered on the local machine.
  733.  
  734.      CCCCoooouuuulllldddd nnnnooootttt ccccaaaallllllll sssseeeerrrrvvvveeeerrrr.... The facsimile server on the remote
  735.      machine did not respond.
  736.  
  737.      NNNNoooo iiiinnnnppppuuuutttt ddddaaaattttaaaa;;;; ttttrrrraaaannnnmmmmiiiissssssssiiiioooonnnn aaaabbbboooorrrrtttteeeedddd.... No data was supplied
  738.      (typically on the standard input).  No facsimile will be
  739.      sent.
  740.  
  741.      EEEErrrrrrrroooorrrr ccccoooonnnnvvvveeeerrrrttttiiiinnnngggg ddddaaaattttaaaa;;;; ccccoooommmmmmmmaaaannnndddd wwwwaaaassss  %%%%ssss...."""" A data conversion
  742.      operation failed; the shell command that was used is
  743.      printed.
  744.  
  745.      CCCCaaaannnn nnnnooootttt ccccoooonnnnvvvveeeerrrrtttt %%%%ssss.... Data needed to be converted for
  746.      transmission, but the required conversion rule was not
  747.      located.  This may indicate that the _H_y_l_a_F_A_X software was
  748.      incorrectly installed; or perhaps that an NFS-mounted
  749.      directory is temporarily unavailable.
  750.  
  751.      %%%%ssss:::: CCCCaaaannnn nnnnooootttt ddddeeeetttteeeerrrrmmmmiiiinnnneeee ffffiiiilllleeee ttttyyyyppppeeee.... _s_e_n_d_f_a_x was unable to
  752.      deduce the type of the file.
  753.  
  754.      %%%%ssss:::: NNNNooootttt aaaa rrrreeeegggguuuullllaaaarrrr ffffiiiilllleeee.... The file is something other than a
  755.      regular file; for example, a directory.
  756.  
  757.      The following messages may be printed by _s_e_n_d_f_a_x.  These
  758.      messages describe problems encountered by the server process
  759.      on the remote machine.  This list is incomplete; other
  760.      messages may be generated by the server under unusual
  761.      circumstances.
  762.  
  763. FFFFIIIILLLLEEEESSSS
  764.      ~/.hylarc                             per-user configuration file
  765.      /usr/freeware/lib/fax/hyla.conf       system-wide configuration file
  766.      /usr/freeware/lib/fax/sendfax.conf    system-wide configuration file
  767.      /usr/freeware/lib/fax/typerules       file type and conversion rules
  768.      /usr/freeware/lib/fax/pagesizes       page size database
  769.      /usr/freeware/lib/fax/dialrules       optional client dialstring rules
  770.      /usr/freeware/bin/faxcover            for generating cover sheets
  771.      /usr/freeware/sbin/textfmt            for converting text to PostScript
  772.      /usr/freeware/sbin/sgi2fax            for converting SGI RGB images
  773.      /usr/tmp/sndfaxXXXXXX                 temporary files
  774.  
  775. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  776.      _a_t(1), _h_y_l_a_f_a_x(1), _f_a_x_a_l_t_e_r(1), _f_a_x_c_o_v_e_r(1), _f_a_x_m_a_i_l(1),
  777.      _f_a_x_r_m(1), _f_a_x_s_t_a_t(1), _s_g_i_2_f_a_x(1), _t_e_x_t_f_m_t(1), _h_f_a_x_d(1M),
  778.      _h_y_l_a_f_a_x(4F), _t_y_p_e_r_u_l_e_s(4F)
  779.  
  780.  
  781.  
  782.  
  783.  
  784.  
  785.  
  786.  
  787. Page 12                                         (printed 6/24/99)
  788.  
  789.  
  790.  
  791.